feat: add codespell for markdown spell checking - #148
Merged
Conversation
Add codespell as a spell checker for catching typos in skill files, flow files, and documentation. Includes pre-commit hook, Makefile target (validate-spelling), and CI workflow. Signed-off-by: Tomer Figenblat <tfigenbl@redhat.com>
TomerFi
requested review from
dmartinol,
ikrispin,
nemerna and
r2dedios
as code owners
July 24, 2026 15:24
ikrispin
reviewed
Jul 27, 2026
ikrispin
left a comment
ikrispin
left a comment
Contributor
There was a problem hiding this comment.
Nice addition!
From what I've checked there might be only one issue - codespell-project/actions-codespell@v2.1 defaults skip to ./.git and always passes --skip on the CLI and treats CLI flags as overrides of the config file, so I think the CI ends up ignoring the skip list in .codespellrc (*.json, dist, etc.). This way local and CI can diverge.
Possible fixes could be either pass the same skip / ignore_words_file via the action with: block, or run uv run codespell in CI so it picks up .codespellrc the same way as make validate-spelling?
Signed-off-by: Tomer Figenblat <tfigenbl@redhat.com>
Member
Author
Signed-off-by: Tomer Figenblat <tfigenbl@redhat.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
make validate-spellingtarget, and CI workflowcna,te,pre-select)Notes
actions/checkoutto v4.2.1 to match existing workflows. A bump to v7 across all workflows can be done separately..codespellrcautomatically (both pre-commit and CI)Closes #145